home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / SetRecLmt.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  2.6 KB  |  68 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/SetRecLmt.3,v 1.1 93/07/07 16:35:18 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) SetRecLmt.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_SetRecursionLimit tclc 7.0
  32. .BS
  33. .SH NAME
  34. Tcl_SetRecursionLimit \- set maximum allowable nesting depth in interpreter
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. int
  40. \fBTcl_SetRecursionLimit\fR(\fIinterp, depth\fR)
  41. .SH ARGUMENTS
  42. .AS Tcl_Interp *interp
  43. .AP Tcl_Interp *interp in
  44. Interpreter whose recursion limit is to be set.
  45. Must be greater than zero.
  46. .AP int depth in
  47. New limit for nested calls to \fBTcl_Eval\fR for \fIinterp\fR.
  48. .BE
  49.  
  50. .SH DESCRIPTION
  51. .PP
  52. At any given time Tcl enforces a limit on the number of recursive
  53. calls that may be active for \fBTcl_Eval\fR and related procedures
  54. such as \fBTcl_GlobalEval\fR.
  55. Any call to \fBTcl_Eval\fR that exceeds this depth is aborted with
  56. an error.
  57. By default the recursion limit is 1000.
  58. .PP
  59. \fBTcl_SetRecursionLimit\fR may be used to change the maximum
  60. allowable nesting depth for an interpreter.
  61. The \fIdepth\fR argument specifies a new limit for \fIinterp\fR,
  62. and \fBTcl_SetRecursionLimit\fR returns the old limit.
  63. To read out the old limit without modifying it, invoke
  64. \fBTcl_SetRecursionDepth\fR with \fIdepth\fR equal to 0.
  65.  
  66. .SH KEYWORDS
  67. nesting depth, recursion
  68.